Skip to content

Add MkDocs Material documentation site#28

Merged
saksham2001 merged 6 commits into
mainfrom
docs/mkdocs-material
Jun 28, 2026
Merged

Add MkDocs Material documentation site#28
saksham2001 merged 6 commits into
mainfrom
docs/mkdocs-material

Conversation

@saksham2001

Copy link
Copy Markdown
Owner

Summary

Sets up a unified docs site for PulseLoop covering both the iOS and Android ports, themed to match the project.

What's included

  • MkDocs Material config (mkdocs.yml), brand CSS, logo/favicon, and requirements-docs.txt
  • Getting Started: iOS + Android
  • Hardware: overview + per-manufacturer pages (Jring/56ff, Colmi/Yawell, premium rings)
  • Platforms: iOS vs Android comparison
  • Project: roadmap, architecture, contributing, privacy
  • Moved README diagrams into docs/images/ and updated all references

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 📟 New / improved wearable support (BLE driver layer)
  • 🤖 Coach / LLM change (tools, prompts, orchestration)
  • 🎨 UI / DesignSystem change
  • 🧹 Refactor / chore (no behavior change)
  • 📝 Docs only
  • ⚠️ Breaking change (existing data, settings, or APIs change)

How was this tested?

  • Added / updated unit tests (PulseLoopTests)
  • Ran the test suite locally (⌘U in Xcode)
  • Tested on a physical device with a real ring — model:
  • Tested with demo data (-seedDemo YES, no hardware)
  • N/A (docs / non-code change)

Privacy & data

  • This change does not send health data off-device without explicit user action.
  • No secrets, API keys, or personal data are committed.
  • N/A

Checklist

  • My code follows the project's style (SwiftLint passes).
  • I ran the tests and they pass.
  • I updated docs / README where relevant.
  • I read the Contributing guide.

@saksham2001 saksham2001 changed the title added mkdocs Add MkDocs Material documentation site Jun 28, 2026
@saksham2001 saksham2001 merged commit f15bd73 into main Jun 28, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant